2. EL 8
  3. leapp
  4. leapp(1)

Scroll to navigation

LEAPP(1) User Commands LEAPP(1)

NAME

leapp - command line interface for upgrades between major OS versions

SYNOPSIS

leapp [-h|--help] [--version] <command> [command options]

DESCRIPTION

leapp is a command line utility for running specific workflows related to upgrading between major OS releases. Currently, it's able to perform upgrades from RHEL 7 to RHEL 8.

OPTIONS

-h, --help
Show usage info and exit.

--version
Show version number of the utility and exit.

COMMANDS

preupgrade
Generates a pre-upgrade report.

upgrade
Upgrades the current system to the next available major version.

answer
Manages answerfile generation: registers persistent user choices for specific dialog sections.

list-runs
Lists previous leapp upgrade executions.

COMMAND SPECIFIC OPTIONS

preupgrade/upgrade

--debug
Print all available log messages (debug, info, warning, error, critical) and the output of executed commands to stderr.
By default only error and critical level messages are printed.

--verbose
Print all but debug log messages (info, warning, error, critical) to stderr.
By default only error and critical level messages are printed.

--enablerepo <repoid>
Enable specified repository. Can be used multiple times.

--no-rhsm
Skip actions that use Red Hat Subscription Manager. You'll also have to supply custom repositories through --enablerepo (see above).

--whitelist-experimental <ActorName>
Enable an experimental actor. Can be used multiple times.
To use this variable, LEAPP_UNSUPPORTED has to be set. See Developer variables for more information.

--report-schema <version>
Force the report format to conform to a specific version of the report schema. Expected values: 1.0.0, 1.1.0. Defaults to 1.1.0.

--reboot
(upgrade only) Automatically perform reboot when requested.

--resume
(upgrade only) Continue the last execution after it was stopped (e.g. after reboot).

answer

--add
If set, sections will be created even if missing in original answerfile.

--section <dialog_sections>
Register answer for a specific section in the answerfile. Can be used multiple times.

ENVIRONMENT

If the argument for the environment variables below is not specified, it is possible to set them to either 1 (true) or 0 (false). They default to 0.

LEAPP_CONFIG

Overrides the default location of leapp.conf. If not specified, .leapp/leapp.conf is used when the command is executed inside a leapp repository, otherwise the default /etc/leapp/leapp.conf is used.

LEAPP_LOGGER_CONFIG

Overrides the default location of logger.conf. If not specified, the default /etc/leapp/logger.conf is used.

LEAPP_ENABLE_REPOS

Specify repositories (repoids) split by comma, that should be used during the in-place upgrade to the target system. It's overwritten automatically in case the --enablerepo option of the leapp utility is used. It's recommended to use the --enablerepo option instead of the envar.

LEAPP_DEBUG

Enables debug logging. Equivalent to --debug, which takes precedence.

LEAPP_VERBOSE

Enables debug logging. Equivalent to --verbose, which takes precedence.

LEAPP_GRUB_DEVICE

Overrides the automatically detected storage device with GRUB core (e.g. /dev/sda).

LEAPP_NO_RHSM

Skip actions that use Red Hat Subscription Manager. Equivalent to --no-rhsm, which takes precedence.

LEAPP_OVL_SIZE

For each XFS partition created with ftype=0, leapp creates an overlay file in order to proceed. This option sets the size (in MB) of every such file. Defaults to 2048.

LEAPP_SERVICE_HOST

Overrides the host of the service to which leapp connects to fetch necessary data files in case they are missing. The used protocol (http:// or https://) must be specified. Defaults to https://cert.cloud.redhat.com.

LEAPP_PROXY_HOST

If set, leapp will use this proxy to fetch necessary data files in case they are missing. The used protocol (http:// or https://) must be specified.

Developer variables

These variables shouldn't be needed under typical circumstances.

LEAPP_UNSUPPORTED

Necessary in case you use any variable starting with LEAPP_DEVEL (see below) or use --whitelist-experimental.

By setting this variable to 1, you acknowledge that the upgrade is not going to be supported by Red Hat.

LEAPP_DEVEL_RPMS_ALL_SIGNED

If set, leapp will consider all installed RPMs to be signed by Red Hat and upgrade them. By default, leapp only handles RPMs signed by Red Hat. What happens with RPMs not signed by Red Hat is undefined.

LEAPP_DEVEL_TARGET_RELEASE <version>

Changes the default target RHEL 8 minor version.

LEAPP_DEVEL_SKIP_CHECK_OS_RELEASE

If set, leapp will not check whether the source RHEL 7 version is the supported one.

LEAPP_DEVEL_DM_DISABLE_UDEV

Disables udev support in libdevmapper, dmsetup and LVM2 tools globally without a need to modify any existing configuration settings. Useful if the system environment does not use udev.

LEAPP_DEVEL_SOURCE_PRODUCT_TYPE <product_type>

Specifies source product type. Expected values: ga, beta, htb. Defaults to ga.

LEAPP_DEVEL_TARGET_PRODUCT_TYPE <product_type>

Specifies target product type. Expected values: ga, beta, htb. Defaults to ga.

EXIT CODES

0 - No error occurred.

1 - Any actor in a workflow reported an error (through calling report_error or raising StopActorExecutionError).

REPORTING BUGS

Report bugs to bugzilla (https://bugzilla.redhat.com) under the `Red Hat Enterprise Linux 7` product and the `leapp-repository` component.

SEE ALSO

snactor(1)

More info available at https://leapp.readthedocs.io/.

2024-02-13 leapp 0.17.0